Skip to main content

X Tools

The X Tool is backed by X OAuth support to allow you to authenticate into your X account and use it to search for tweets across X. Once authenticated, your X Account will stay refreshed in the background through refreshing OAuth.

Currently, X is supported for the following Tool(s):

  • X - Search Tweets

X Tool listing

The Tool can be added via finding it from the library listing.

Add the Tool to your library.

After providing a name to save the tool with, you will provide the Authentication.

X Tool

Select X OAuth, followed by "Create a New Credential" in the dropdown below. You can also select a previously provided credential on this page.

X OAuth

Authorize your X/Twitter account to select provide the required permissions to use the Tool.

X Token

Save the Token as a new Credential. Once saved, you can add the Tool to an Agent via the Agent Canvas, by following the Tools setup guide.

Using the X Search tool​

The X Search tool can be used to query Recent tweets over the last 7 days via the X API. Let's deploy an Agent with this tool.

Once deployed, you can use the tool to interact with X by asking it to retrieve tweets about a specific topic or from an account.

  1. Search X for Tweets: X results

  2. Search X based on a User account: X results

  3. Page through results: X Tool supports pagination by allowing the user to scroll through additional results by querying requests such as "Show me more results", or "Are there more tweets?". X more results

  4. Ask for results by specifying that in your request. To ask for more results, you can also specify this in the reqest itself: X multiple tweets

For improved responses, it is recommended that you add a prompt to your model as well, providing details of your search use case, specific accounts you interact with or your domain.